Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 088 / catpatch.arc / CATPATCH.DOC < prev

Wrap

Text File | 1987-12-17 | 13.5 KB | 318 lines

CATPATCH Version 1.0 Written and (C) 1987 Michael Cleverly Acheron! [801] 298-2812 RELEASE DATE: December 17, 1987 "The gateway to a flood of WILDCAT! doors" What is CATPATCH ---------------- Catpatch is a set of QuickBasic sub-module's that allow easy writting of any door. These routines open and close the COM Ports, monitor carrier, and recycle to the BBS if it's dropped, as well as all I/O between the door and the user. This code is very simmilar to DoorPatch (PCBoard) and DoorMerge (RBBS). Almost *any* BASIC game/program that does not use sound or high resolution graphics could be turned into a door, with minor editing using these routines! Why did you write CATPATCH? --------------------------- I wrote CatPatch for several reasons; The first being I needed a easy way to print stuff and get back input from the user for the ESP Door. (My first and the third ever written for WILDCAT.) I have loved doors ever since I have been calling BBS's during the days before I got an IBM Compatible. I also wanted WILDCAT to get the recognition it deserves. In my opinion WILDCAT is the *best* BBS software avaible, far superior to RBBS or PCBoard (although it is lacking in two major areas which don't concern most SysOps's; NetMail and Multi-Nodes). I didn't want to see WildCat become dependent soley on PCBoard doors like Collie (aka Phoenix) is. Hopefully you SysOp's will write tons of doors to share with us all. <grin> Requirements for CatPatch ------------------------- 1. WILDCAT 1.10 <obviously> 2. QuickBasic 3.0+ (These routines only use line numbers for labels, so may need editing to work with other Basic compilers. You will have to experiment and see.) 3. A little knowledge of BASIC. (Not alot, just a little.) 4. An idea for a door <obviously> How to use CatPatch in your doors --------------------------------- The first thing you need to do is load QuickBasic via: QB /W/X/C:512 This will toggle the 'Error Trapping' and 'Resume' functions as well as allocating more buffers so we can have the neccessary files open. Next at the *very* beginning of your program, include the following statement: '$INCLUDE: 'CATPATCH.BAS' Then at the *very* bottom of your program, include this statement: '$INCLUDE: 'CATPACH2.BAS' Then near the top of your program on LINE 9, insert the name of your door program in the variable DOOR.NAME$, and the command: ON.AT$=TIME$ Then procced to write your door, following is a list of conversions to commonly used BASIC commands needed to send output to both the console and the user: BASIC COMMAND CATPATCH Equivalent -------------------------------------------------------------------------- PRINT Store your text in the variable LN$ and do a GOSUB OUT.PUT PRINT ; (Print with no carriage return) Store your text in the variable LN$ and set NORET=1 and do a GOSUB OUT.PUT INPUT Store any text needed to be printed before the input and do a GOSUB IN.PUT (the text in LN$ will automatically be printed with out a carriage return.) The users input is returned in the variable ARG$ COLOR x,x The following ANSI colors are avaible to you with CATPATCH: BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, and WHITE. If you wish to use these colors then do a GOSUB color (I.E. GOSUB RED to print in RED, GOSUB BLUE to print in BLUE etc) The text in LN$ will be printed automatically without a carriage return, allowing you to have more than one color on a line. When you do a GOSUB whatevercolor the text is printed in Graphics mode to the local screen, and in ANSI *only* if the user has ANSI graphics ON in WILDCAT. Since no carriage return is sent if you are done, you will need to do a GOSUB OUT.PUT with nothing in it to advance down to the next line. CLS Set LN$=CHR$(12), after doing this do a GOSUB LNE25 to establish the bar on the bottom of the screen so the SysOp knows who is in the door. BEEP **PLEASE DON'T WAKE UP THE SYSOP!** If you need to send a bell, or other code that might 'annoy' the SysOp (especially at night) put it in the variable OUT$, this is sent *only* to the remote user and not the console. (I.E. for a bell do a OUT$=CHR$(7) and then a GOSUB OUT.PUT) Variables avaible for your manipulation --------------------------------------- AUTHOR.NAME$ Your name AUTHOR.PHONE$ Your BBS's Phone Number AUTHOR.BBS$ Your BBS's Name AUTHOR.BAUD$ The baud rates you support -- This information will be displayed as a short BBS ad, along with mine when the SysOp shell's to DOS from within the door program -- BBS.NAME$ The name of the BBS the door is being run on SYSOP.FIRST$ The first name of the System Operator SYSOP.LAST$ The last name of the System Operator PARAM$ The name of the config file passed on the command line when the door was run FIRST$ The users's first name LAST$ The users's last name USER.NAME$ The users complete name WC$(x) Where x=a number from 1-28 which corresponds with the description of the field with that number as explained on PAGE 226 of the WILDCAT 1.10 Users Manual DOOR.NAME$ You should set this to the name of your Door Program LN$ Put text to be printed in this variable (as described above) ARG$ Users input (as described above) OUT$ Text sent only to user (as described above) Configuration File Setup ------------------------ The config file that is passed on the same line when calling your door program *must* have the following info in it! COM2 <=-- Com Port you use Acheron <=-- BBS Name Michael <=-- SysOp's First Name Cleverly <=-- SysOp's Last Name \WILDCAT\CALLINFO.BBS <=-- Location of the CALLINFO.BBS File If you need aditional information, you can re-open this file, read through the first 5 lines, till you come to info specific for your door. (You *should* use file number one, and six + for any files you have to open... two through five are already in use.) For LOCAL MODE Operation: COM0 <=-- Indicates local mode Acheron <=-- BBS Name Michael <=-- SysOps First Name Cleverly <=-- SysOps Last Name \WILDCAT\DOORS\LOCAL.BBS <=-- A FAKE copy of CALLINFO, if you dont have one reffer to page 226 of the WILDCAT 1.10 Manual. One thing to remember, in the documentation for your door program, be sure to specify the setup for the .CFG file. Function Keys Active while in the Door Program ---------------------------------------------- The following function keys are avaible to the SysOp while a user is in the door: [F1] Prints a list of options (same as the one here) [F2] Shell to DOS -- This will invoke a 2nd command proccessor ** WARNING ** - IF CTTY has been redirected to COM2 or GATE2 etc and NOT the Console (which is default) then the user will be able to see what you do, and execute their own DOS commands, Which could be fatal. This is *not* a problem if your LIVE.BAT file does not redirect the output. Also you *MUST* be back in the same directory as the door when you 'EXIT' or the door could spit out an error on the next file accessing attempt. [F8] Force User Off -- This will prompt you for how many minutes until the user is sent back to WILDCAT, if you want to boot him off immediatly then set this to a very low number, you can increase his time in the door this same way. NOTE: The time change will not subtract or add time avaible to the user when he returns to WILDCAT. [F10] Chat with user -- This will allow you to chat with the user, its not too fancy, theres a minor problem with the backspace on the local screen (but it looks perfect on the remote). Time is stopped as far as how much they have left in the door but when WILDCAT is recalled all the time (including CHAT time in the door) will be subtracted. Press [ESC] to exit chat. (You OR the user can exit chat mode.) CatPatch Registration --------------------- Well as the old saying goes, "There's no such thing as a free lunch." Not even in writting Door Software. I am asking a registration fee to help compensate the time that went into writting these routines, and that calling long distance. Your registration will "inspire" me to make changes to improve this code as time goes by. Registration IS required if you write any door programs that utilize this code. Here's how it works: I ask for an initial $15 dollar registration, regardless. Then for each door you write that you charge a registration fee, I ask you to send in a $5 royalty. If you write 10 doors and don't charge a dime then I would excpect a $15 registration, if you wrote 7 doors with no charge and 3 with a fee, then I would excpect a $15 registration and then a $15 royalty for the three doors. When you register you get free limited phone support (during certain hours only) as well as access to a 'door programers conf' for registered users on my BBS. Free updates. Also, if your stuck with a problem, you can upload your door program and let me have a look at it, etc. Mail to: Michael Cleverly 158 East 1650 South Bountiful, Utah, 84010 Registration Form ================= NAME: _______________________ Phone: (____) ____-_______ Date #: (____) ____-______ BBS Name: _________________ Registration #: 87-_______ Address: ____________________ City: ___________________ State: _______ Zip Code: _______-_____ *Password: ________________ *B-Date: ___/____/19___ I am complying with the CATPATCH licensse agreement by registering my copy of CATPATCH. Enclosed is the Fifteen Dollar payment in US Funds required. * Optional. Provide this information *ONLY* if you wish to have a pre- validated account before your first call to our Support BBS. Door Registration ----------------- NAME: _______________ CATPATCH Registration Number: ___________ DOOR NAMES: __________________________________________________________ __________________________________________________________ Total Doors Being Registered: ________ Amount Inclosed: $__________ I am remitting $5 in US Funds for each of the above door programs that I created using CATPATCH I/O routines, and am charging a fee for their use by other SysOps. Technical Help -------------- Technical help is avaible by voice to registered users only. Upon registering you will recieve my voice phone number as well as acceptable hours to call. Technical help is avaible to registered and non-registered users alike (but you are going to register... Right?) on my BBS. Acheron, 300 - 2400 Baud supported, [801] 298-2812. I can also be reaches on these WILDCAT BBS's as well as many others (although here's were I will get your message the fastest, due to limited funds for long distance calling.) * Nick At Nite [801] 964-1889 300-2400 * Well Of Souls [801] 485-6349 1200-9600 * A Million Miles Away [801] 965-9534 1200-2400 All "PCPursuitable!" Well that's about it, if you still don't understand something, contact me on one of the above BBS's. I am look forward to seeing your Doors soon!